docs: add AGENTS.md/CLAUDE.md agent guide, refresh README#6
Open
njbrake wants to merge 1 commit into
Open
Conversation
njbrake
force-pushed
the
docs/agents-guide
branch
4 times, most recently
from
9cfb1b6 to
795f87e
Compare
Add an AGENTS.md agent guide (CLAUDE.md symlinked to it, matching the otari repo) covering the SDK architecture, both auth modes, the endpoint-coverage drift gate, and the exact uv build/test/lint commands. README: add the 409 BatchNotCompleteError row, correct the stale 'built on the OpenAI Python SDK' claim, retitle the heading to 'Otari Python Client SDK', and rebrand otari-gateway wording to otari. Drop the internal 'Option C' codename from source docstrings/comments. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
njbrake
force-pushed
the
docs/agents-guide
branch
from
795f87e to
03bdc53
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
the generated
src/otari/_clientcore), the streaming/error-mapping seams, both auth modes,the endpoint-coverage drift gate, and the exact
uvbuild/test/lint commands. CLAUDE.mdis a symlink to it, matching the otari repo.
BatchNotCompleteErrorrow; corrected the stale "built onthe official OpenAI Python SDK" claim (typed from the gateway's OpenAPI spec, no
openaidependency); retitled the heading to Otari Python Client SDK; rebranded
otari-gatewaywording to
otari, the open-source core that powers otari.ai.No logic changes.
Trimmed the otari overview/marketing sections (About otari, the docker Quick Start, Managed Platform, Why otari) and replaced them with a one-line pointer to the main repo. The README now focuses on SDK install/auth/usage.
Added a "Writing style" rule to AGENTS.md (avoid em dashes and double-hyphen separators in prose) and scrubbed the existing em dashes from the README and AGENTS.md.
Normalized the README to the shared SDK layout (Quickstart, Installation, Authentication, Usage, Development, Documentation, Contributing, License) with the same set of usage examples in the same order across all four SDKs (Chat, Streaming, Responses, Messages, Embeddings, Listing models, Moderation, Reranking, Batch, Error handling), plus language-specific extras.